<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: mailbox.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('mailbox_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">mailbox.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="mailbox_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  $Id: mailbox.h,v c0b4c64fcebd 2012/12/07 18:51:55 fp $</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *  This file is part of the IgH EtherCAT Master.</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is free software; you can redistribute it and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  modify it under the terms of the GNU General Public License version 2, as</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  published by the Free Software Foundation.</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  The IgH EtherCAT Master is distributed in the hope that it will be useful,</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *  Public License for more details.</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License along</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> *  with the IgH EtherCAT Master; if not, write to the Free Software</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *  ---</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> *  The license mentioned above concerns the source code only. Using the</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> *  EtherCAT technology and brand is only permitted in compliance with the</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> *  industrial property and similar rights of Beckhoff Automation GmbH.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment"> *****************************************************************************/</span></div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifndef __EC_MAILBOX_H__</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="preprocessor">#define __EC_MAILBOX_H__</span></div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="slave_8h.html">slave.h</a>&quot;</span></div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="mailbox_8h.html#a189582ffd5ea94b41b00482c04968291">   46</a></span>&#160;<span class="preprocessor">#define EC_MBOX_HEADER_SIZE 6</span></div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;uint8_t *<a class="code" href="mailbox_8h.html#ab3a5be80064e09c9e7194d155c62cae8">ec_slave_mbox_prepare_send</a>(<span class="keyword">const</span> <a class="code" href="structec__slave.html">ec_slave_t</a> *, <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *,</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;                                    uint8_t, <span class="keywordtype">size_t</span>);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="keywordtype">int</span>      <a class="code" href="mailbox_8h.html#a9c9f8f70db11c581795e7520c10bb623">ec_slave_mbox_prepare_check</a>(<span class="keyword">const</span> <a class="code" href="structec__slave.html">ec_slave_t</a> *, <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="keywordtype">int</span>      <a class="code" href="mailbox_8h.html#a4d932f3a3716b07460950cf795e89891">ec_slave_mbox_check</a>(<span class="keyword">const</span> <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *);</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="keywordtype">int</span>      <a class="code" href="mailbox_8h.html#a6c8ab58f4b9c8d78153e5d0403bae40b">ec_slave_mbox_prepare_fetch</a>(<span class="keyword">const</span> <a class="code" href="structec__slave.html">ec_slave_t</a> *, <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;uint8_t *<a class="code" href="mailbox_8h.html#a9845c6e71e538cdaf2af6000b16f60c9">ec_slave_mbox_fetch</a>(<span class="keyword">const</span> <a class="code" href="structec__slave.html">ec_slave_t</a> *, <span class="keyword">const</span> <a class="code" href="structec__datagram__t.html">ec_datagram_t</a> *,</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;                             uint8_t *, <span class="keywordtype">size_t</span> *);</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">/*****************************************************************************/</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="slave_8h_html"><div class="ttname"><a href="slave_8h.html">slave.h</a></div><div class="ttdoc">EtherCAT slave structure. </div></div>
<div class="ttc" id="structec__datagram__t_html"><div class="ttname"><a href="structec__datagram__t.html">ec_datagram_t</a></div><div class="ttdoc">EtherCAT datagram. </div><div class="ttdef"><b>Definition:</b> <a href="datagram_8h_source.html#l00087">datagram.h:87</a></div></div>
<div class="ttc" id="structec__slave_html"><div class="ttname"><a href="structec__slave.html">ec_slave</a></div><div class="ttdoc">EtherCAT slave. </div><div class="ttdef"><b>Definition:</b> <a href="slave_8h_source.html#l00176">slave.h:176</a></div></div>
<div class="ttc" id="mailbox_8h_html_a6c8ab58f4b9c8d78153e5d0403bae40b"><div class="ttname"><a href="mailbox_8h.html#a6c8ab58f4b9c8d78153e5d0403bae40b">ec_slave_mbox_prepare_fetch</a></div><div class="ttdeci">int ec_slave_mbox_prepare_fetch(const ec_slave_t *, ec_datagram_t *)</div><div class="ttdoc">Prepares a datagram to fetch mailbox data. </div><div class="ttdef"><b>Definition:</b> <a href="mailbox_8c_source.html#l00127">mailbox.c:127</a></div></div>
<div class="ttc" id="mailbox_8h_html_a9c9f8f70db11c581795e7520c10bb623"><div class="ttname"><a href="mailbox_8h.html#a9c9f8f70db11c581795e7520c10bb623">ec_slave_mbox_prepare_check</a></div><div class="ttdeci">int ec_slave_mbox_prepare_check(const ec_slave_t *, ec_datagram_t *)</div><div class="ttdoc">Prepares a datagram for checking the mailbox state. </div><div class="ttdef"><b>Definition:</b> <a href="mailbox_8c_source.html#l00096">mailbox.c:96</a></div></div>
<div class="ttc" id="mailbox_8h_html_ab3a5be80064e09c9e7194d155c62cae8"><div class="ttname"><a href="mailbox_8h.html#ab3a5be80064e09c9e7194d155c62cae8">ec_slave_mbox_prepare_send</a></div><div class="ttdeci">uint8_t * ec_slave_mbox_prepare_send(const ec_slave_t *, ec_datagram_t *, uint8_t, size_t)</div><div class="ttdoc">Prepares a mailbox-send datagram. </div><div class="ttdef"><b>Definition:</b> <a href="mailbox_8c_source.html#l00051">mailbox.c:51</a></div></div>
<div class="ttc" id="mailbox_8h_html_a4d932f3a3716b07460950cf795e89891"><div class="ttname"><a href="mailbox_8h.html#a4d932f3a3716b07460950cf795e89891">ec_slave_mbox_check</a></div><div class="ttdeci">int ec_slave_mbox_check(const ec_datagram_t *)</div><div class="ttdoc">Processes a mailbox state checking datagram. </div><div class="ttdef"><b>Definition:</b> <a href="mailbox_8c_source.html#l00115">mailbox.c:115</a></div></div>
<div class="ttc" id="mailbox_8h_html_a9845c6e71e538cdaf2af6000b16f60c9"><div class="ttname"><a href="mailbox_8h.html#a9845c6e71e538cdaf2af6000b16f60c9">ec_slave_mbox_fetch</a></div><div class="ttdeci">uint8_t * ec_slave_mbox_fetch(const ec_slave_t *, const ec_datagram_t *, uint8_t *, size_t *)</div><div class="ttdoc">Processes received mailbox data. </div><div class="ttdef"><b>Definition:</b> <a href="mailbox_8c_source.html#l00165">mailbox.c:165</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="mailbox_8h.html">mailbox.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
